<html>
<body>
<h1>XML Plugin</h1>

<div id="content-before">
    <p>If using the defaults, add any XML catalogues you are using to the xml-catalog path and
    add the XML transform library to the xml-transform classpath (e.g. saxon). You will also
        need to add ant-trax to the transform classpath is most cases.
    </p>
</div>

<div id="content-after">
    <hr/>
    <h2>Available Properties</h2>

    <p>By default, any properties defined with a prefix of quokka.subversion.defaults will be used. Each
        target may override any or all of these properties if defined. Any of these properties get
        passed through to the underlying svnkit command line.
    </p>

    <table border="1" cellpadding="2" cellspacing="0">
        <tr>
            <td valign="top"><b>Property</b></td>
            <td valign="top"><b>Description</b></td>
            <td align="center" valign="top"><b>Required</b></td>
        </tr>
        <tr>
            <td>out</td>
            <td>The output file if transforming a single document</td>
            <td>No</td>
        </tr>
        <tr>
            <td>destDir</td>
            <td>The destination directory if transforming mulitple documents</td>
            <td>No</td>
        </tr>
        <tr>
            <td>transformClassPath</td>
            <td>The project path that contains the xml processor to use for the transform</td>
            <td>No</td>
        </tr>
        <tr>
            <td>style</td>
            <td>The stylesheet to use</td>
            <td>Yes</td>
        </tr>
        <tr>
            <td>factory</td>
            <td>The class name of the factory to use. e.g. com.icl.saxon.TransformerFactoryImpl</td>
            <td>No</td>
        </tr>
        <tr>
            <td>factory.params[]</td>
            <td>A map of strings that are passed to the factory as parameters</td>
            <td>No</td>
        </tr>
        <tr>
            <td>params[]</td>
            <td>A map of strings that are passed to the stylesheet as parameters</td>
            <td>No</td>
        </tr>
        <tr>
            <td>outputProperty[]</td>
            <td>A map of strings that are passed as output properties to the transform</td>
            <td>No</td>
        </tr>
        <tr>
            <td>catalogPath</td>
            <td>The project path containing any catalogues used during the tranform, such as the docbook catalogue.</td>
            <td>No</td>
        </tr>
        <tr>
            <td valign="top">basedir</td>
            <td valign="top">where to find the source XML file, default is the
              project's basedir.</td>
            <td align="center" valign="top">No</td>
          </tr>
          <tr>
            <td valign="top">extension</td>
            <td valign="top">desired file extension to be used for the targets. If not
              specified, the default is &quot;.html&quot;.  Will be ignored if
              a nested <code>&lt;mapper&gt;</code> has been specified.</td>

            <td align="center" valign="top">No</td>
          </tr>
          <tr>
            <td valign="top">force</td>
            <td valign="top">Recreate target files, even if they are newer
              than their corresponding source files or the stylesheet.</td>
            <td valign="top" align="center">No; default is false</td>
          </tr>

          <tr>
            <td valign="top">includes</td>
            <td valign="top">comma- or space-separated list of patterns of files that must be included.
              All files are included when omitted.</td>
            <td valign="top" align="center">No</td>

          </tr>
          <tr>
            <td valign="top">includesFile</td>
            <td valign="top">the name of a file. Each line of this file is taken to be
              an include pattern</td>
            <td valign="top" align="center">No</td>
          </tr>
          <tr>

            <td valign="top">excludes</td>
            <td valign="top">comma- or space-separated list of patterns of files that must be excluded.
              No files (except default excludes) are excluded when omitted.</td>
            <td valign="top" align="center">No</td>
          </tr>
          <tr>
            <td valign="top">excludesFile</td>
            <td valign="top">the name of a file. Each line of this file is taken to be
              an exclude pattern</td>

            <td valign="top" align="center">No</td>
          </tr>
          <tr>
            <td valign="top">defaultExcludes</td>
            <td valign="top">indicates whether default excludes should be used or not
              (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

            <td valign="top" align="center">No</td>
          </tr>
          <tr>
            <td valign="top">scanIncludedDirectories</td>

            <td valign="top">If any directories are matched by the
              includes/excludes patterns, try to transform all files in these
              directories.  Default is <code>true</code></td>
            <td valign="top" align="center">No</td>
          </tr>
    </table>
</div>


</body>
</html>